Child Protection
Domain Message Specification

CP-ISLocalAuthorityUpload Tabular View

REPC_RM000002GB01
File
This class is the file header class.
Used by:
[1..1] [M] creationTime (TS)

Model Attribute Description

The HL7 attribute creationTime is used to indicate when the local authority upload file was created.

Implementation in XML Instance

The XML attribute value of the XML element creationTime shall be populated with the time the local authority upload file was created using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:

  • yyyy is the year
  • mm is the month
  • dd is the day
  • hh is the hour
  • mm is the minutes
  • ss is the seconds
  • [+|-ZZzz] is the time zone offset in hours and minutes
Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present.
[1..1] [M] id (II)

Model Attribute Description

The HL7 attribute id uses an identifying sequence number to identify the local authority upload file.

Implementation in XML Instance

The XML element id shall carry the sequence number as follows:

  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.46"
  • The XML attribute extension shall contain the identifying sequence number.

Schema Constraint

The attribute root is prohibited in the schema and therefore does not appear in the "on the wire" instance.

[1..1] [M] transmissionQuantity (INT)

Model Attribute Description

The HL7 attribute transmissionQuantity is used to carry the number of records contained in the file.

Implementation in XML Instance

The XML element transmissionQuantity should be populated as follows:
  • The XML attribute value shall an integer to indicate the total number of records.
[1..1] [M] communicationFunctionSnd (CommunicationFunctionSnd)
A link to the communication function send class.
[1..*] [M] record (Record)
A link to the record class.
CommunicationFunctionSnd
This class is the send function class used to link the sender's details to the batch.
Used by: File
[1..1] [M] typeCode (CS { CNE: CommunicationFunctionType } )
{ Fixed="SND" }

Model Attribute Description

The HL7 attribute typeCode uses a code from the communicationFunctionType vocabulary to describe this class as a send function.

Implementation in XML Instance

The XML attribute typeCode is fixed to "SND".

Schema Constraint

  • The attribute typeCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] organisation (Organisation)
A link to the sending organisation.
Organisation
This class details the organisation which is sending the CP-IS upload.
Used by:
[1..1] [M] classCode (CS { CNE: EntityClass } )
{ Fixed="ORG" }

Model Attribute Description

The HL7 attribute classCode describes this class as an organisation.

Implementation in XML Instance

The XML attribute classCode is fixed to "ORG".

Schema Constraint

  • The attribute classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] determinerCode (CS { CNE: EntityDeterminer } )
{ Fixed="INSTANCE" }

Model Attribute Description

The HL7 attribute determinerCode describes this class as an instance of an organisation.

Implementation in XML Instance

The XML attribute determinerCode is fixed to "INSTANCE".

Schema Constraint

  • The attribute determinerCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] id (II)

Model Attribute Description

The HL7 attribute id uses an ODS code as an identifier that uniquely identifies the sending organisation. The ODS code should identify the organisation at either the site level or organisation level. Where possible the organisation should be identified at the site level. ODS codes were formerly known as NACS codes.

Implementation in XML Instance

When ODS site code is used then the XML element id is populated in the following way:

  • The XML attribute root shall contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.19.2"
  • The XML attribute extension shall contain the ODS site code.

When ODS organisation code is used then the XML element id is populated in the following way:

  • The XML attribute root shall contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.19.1"
  • The XML attribute extension shall contain the ODS organisation code.
[1..1] [M] name (ON)

Model Attribute Description

The HL7 attribute name uses the description of the organisation associated with the ODS code.

Implementation in XML Instance

The XML element name will carry the description associated with the ODS code carried in the XML attribute extension of the XML element id.
[1..2] [M] telecom (SET<TEL>)

Model Attribute Description

The HL7 attribute telecom provides a contact telephone number for the organisation.

Implementation in XML Instance

This XML element telecom should be populated as below:

The XML attribute value of the XML element telecom should contain the telephone number:

  • For a telephone number the actual telephone number would be prefixed with tel:

The XML attribute use of the XML element telecom must be used to give further information about the type of contact details contained in the XML attribute value. Only the use values listed below are recommended for the contact details:

Code Definition
EC Emergency Contact - A contact used by clinicians in Out of Office hours (this is mandatory).
WP
Work place - A contact during business hours (this is optional, but if it is available it should be included).

Record
The Record class is a dummy class used to connect the file class to the record.
Used by: File
[1..1] [M] CP-ISRecord (CP-ISRecord)
CP-ISRecord
This class represents the child protection record information which is being requested to be uploaded on to CP-IS.
Used by:
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="ACTN" }

Model Attribute Description

The HL7 attribute classCode describes this class as an action.

Implementation in XML Instance

The XML attribute classCode is fixed to "ACTN".

Schema Constraint

  • The attribute classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="RQO" }

Model Attribute Description

The HL7 attribute moodCode describes this class as an action request.

Implementation in XML Instance

The XML attribute moodCode is fixed to "RQO".

Schema Constraint

  • The attribute moodCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] code (CV { CNE:CP-ISMessageType } )
{ Fixed="01" }

Model Attribute Description

The HL7 attribute code uses a code from the CP-ISMessageType vocabulary to describe this control act as a CP-IS message.

Implementation in XML Instance

The Coded Plain flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain a fixed value of "01"
  • The XML attribute codeSystem shall contain a fixed value of "2.16.840.1.113883.2.1.3.2.4.17.470"
  • The XML attribute displayName shall contain a fixed value of "CP-IS Local Authority Upload".

Schema Constraint

  • The attribute code is prohibited in the schema and therefore does not appear in the "on the wire" instance.
  • The attribute codeSystem is prohibited in the schema and therefore does not appear in the "on the wire" instance.
  • The attribute displayName is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..3] [M] pertinentInformation
This class links the CP-IS Record class to the pertinent child protection plan type.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="PERT" }

The HL7 attribute typeCode uses a code to describe this class as pertinent information.

Implementation in XML Instance

The XML attribute typeCode is fixed to "PERT".

Schema Constraint

  • The attribute typeCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] contentId (II) { "NPFIT-100017#Act" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.


Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] pertinentChildProtectionInformationChoice (ChildProtectionInformationChoice)
A link to the choice of child protection information.
[1..2] [M] subject

A class which is a participation of subject.

The child who is the subject of the CP-IS record.

The table below shows which subject template is used for the type of CP-IS information.

CP-IS information type

Unborn child subject template
Child subject template
Child Protection Plan Information NO
YES
Looked After Child Information NO
YES
Unborn Child Plan Information YES
NO

[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="SBJ" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a subject participation.

Implementation in XML Instance

The XML attribute typeCode is fixed to "SBJ".

Schema Constraint

  • The attribute typeCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
[1..1] [M] contentId (II) { "NPFIT-100035#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.


Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] participant (SubjectChoice)
A link to the choice of subjects.
SubjectChoice
A choice of subjects.
Used by: CP-ISRecord
[1..1] : Template1
ChildProtectionInformationChoice
A choice of child protection information.
Used by: CP-ISRecord
[1..1] : Template2